Skip to main content

session/start/payment

session/start/payment

This request is used to start a payment within an existing session. In the parameters, you can pass data necessary to perform a payment or change pieces of data that have already been passed.

Endpoint

api/v1/session/start/payment

Request parameters

NameMandatoryTypeDescription
session_id+stringPayment session identifier
payment_details-PaymentDetailsPayment data
amount_details-AmountDetailsAmount. Transmitted in the USD decimal format. If you are sending 100 USD, you will need to specify 10000
participant_details-ParticipantDetailsInformation on the sender and recipient)
customer-CustomerRecipient's data in your system
payment_options-PaymentOptionsAdditional payment parameters
metadata-*Additional information. Any data you need in order to perform the operation. Returned in responses and webhooks

If you did not specify payment_details, amount_details, and customer in your session/create request, make sure you specify them in this request, since in this case they are mandatory.

Request example

curl -X POST \
https://demo.smart-glocal.com/api/v1/session/start/payment \
-H 'content-type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: e05794ee22f47ee5f674e63303ea227e6113f42359f332945304f1e958542fff' \
-d '{
"session_id": "3230",
"payment_details": {
"type": "card",
"card": {
"type": "bank_card",
"bank_card": {
"number": "4242***4242",
"expiration_month": "01",
"expiration_year": "29",
"security_code": "***"
}
}
}
},
"metadata": "good"
}'

Response parameters

NameMandatoryTypeDescription
status+stringStatus. Options: error, ok
session-PaymentSessionPayment session
error-ErrorError

Successful response example

{
"status": "ok",
"session": {
"id": "3230",
"status": "in_progress",
"created_at": "2018-05-27T02:03:00.000000Z",
"updated_at": "2018-05-27T02:03:00.000000Z",
"acquiring_payments": [
{
"id": "2018",
"status": "in_progress",
"created_at": "2018-05-27T02:03:00.000000Z",
"customer": {
"reference": "user123",
"contacts": [
{
"email": "user@gmail.com"
}
]
},
"payment_details": {
"type": "card",
"card": {
"last4": "4242",
"brand": "visa"
}
},
"amount_details": {
"amount": 10000,
"currency": "usd"
},
"metadata": "good"
}
]
}
}

Unsuccessful response example

    {
"error": {
"code": "error code",
"description": "error description"
},
"status": "error"
}