Soft/Dynamic Descriptor

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "terminal": {
        "id": 24
    },
    "amount": "9.99",
    "source": "Internet",
    "level": 1,
    "card": {
        "name": "John Wick",
        "number": 5146312200000035,
        "exp": "12/30",
        "cvv": "998",
        "address": {
            "country": "United State of America",
            "state": "CA",
            "city": "Calabasas",
            "street": "8320",
            "zip": "85284"
        }
    },
    "order": {
        "description": "Grandmas Cookie Store"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/payment/sale' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "terminal": {
        "id": 24
    },
    "amount": "9.99",
    "source": "Internet",
    "level": 1,
    "card": {
        "name": "John Wick",
        "number": 5146312200000035,
        "exp": "12/30",
        "cvv": "998",
        "address": {
            "country": "United State of America",
            "state": "CA",
            "city": "Calabasas",
            "street": "8320",
            "zip": "85284"
        }
    },
    "order": {
        "description": "Grandmas Cookie Store"
    }
}'

Responses

🟢200Sale with Dynamic Descriptor

application/json

Body

Example

{
    "id": 887,
    "amount": "9.99",
    "origin": null,
    "type": "Auth",
    "level": 1,
    "authCode": "VTLMC1",
    "parent": {
        "id": null
    },
    "terminal": {
        "id": 24
    },
    "threeds": {
        "id": null
    },
    "card": {
        "bin": 514631,
        "name": "John Wick",
        "number": 35,
        "exp": "2030-12-31",
        "verification": {
            "cvv": "M",
            "address": "Y"
        },
        "networkTransactionId": "1212MCC111168**"
    },
    "contact": {
        "name": null,
        "phone": null,
        "email": null
    },
    "externalId": null,
    "isRecurring": "No",
    "split": null,
    "refunded": false,
    "captured": true,
    "history": [
        {
            "id": 888,
            "type": "Capture",
            "amount": "9.99",
            "createdOn": "2023-05-09 16:02:30"
        }
    ],
    "order": {
        "identifier": null,
        "date": null,
        "invoice": null,
        "description": "Grandmas Cookie Store",
        "note": null,
        "summaryCommodityCode": null,
        "supplierRefNo": null,
        "tax": {
            "amount": null,
            "details": []
        },
        "discount": {
            "amount": null
        },
        "customer": {
            "id": null,
            "vat": null
        }
    },
    "feeTransaction": null,
    "batch": {
        "id": null,
        "number": null,
        "batchedOn": null
    },
    "ip": {
        "address": "173.239.211.198",
        "isp": "Ipxo Limited",
        "type": "hosting",
        "location": {
            "city": "New York",
            "state": "NY",
            "country": "US",
            "zip": "10118"
        },
        "info": {
            "isAnonymous": "Yes",
            "isAnonymousVpn": "No",
            "isPublicProxy": "No",
            "isHostingProvider": "No",
            "isTorExitNode": "No"
        }
    },
    "status": {
        "status": "Approved",
        "reason": null
    },
    "updatedOn": "2023-05-09 16:02:32",
    "createdOn": "2023-05-09 16:02:29"
}