1. Create

You can authorize Paywall with your own access credentials through the supported Card Creation providers and create virtual cards.

Create Virtual Card

POST {{Base Address}}/api/paywall/card/production/virtual

Simply sending a request to the provided address above will suffice. You can use 'Base Address' as you wish for both the test environment and the production environment.

Important: In order to use the 'Virtual Card - Creation' service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PaymentAPI Address

The header information that needs to be sent to the service is as follows:

Parameter
Type
Compulsory
Explanation

apikeyprivate

string

Yes

The Private Key obtained from the merchant panel.

apiclientprivate

string

Yes

The Private Client obtained from the merchant panel.

The parameters that need to be sent to the service are as follows:

Parameter
Type
Compulsory
Explanation

CardProductionKey

string

Yes

The provider key information to which the card will be created and linked to your account.

Description

string

Yes

The person or description to which the card will be associated.

Phone

string

Yes

The phone number to which the card will be associated.

ExternalId

string

No

The identity information of the card in your system.

{
    "CardProductionKey": "Papara",
    "Description": "Card Holder",
    "Phone": "5554443322",
    "ExternalId": "1231231a3"
}

The response returned from the service:

Parameter
Type
Explanation

Body

object

JSON containing detailed information about the card.

ErrorCode

int

Error code. Returns '0' if the operation is successful.

Result

bool

It returns a value of true or false. Returns 'true' if the operation is successful.

Message

string

If the operation is unsuccessful, this is the specified error message, providing language support according to the locale parameter.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "CardId": 1786886,
        "CardIdExternal": 66736,
        "ExternalId": "1231231a3",
        "CardNumber": "5297990038619840",
        "ExpiryMonth": "08",
        "ExpiryYear": "27"
    }
}

Last updated