/moto/api/v1

tip

Before continuing, you'll need to be familiar with the following sections:

• API Call Authentication Tutorial
• How to Build API Requests
• API Response Format

What can be done with Pay By Link?

• Payments with multiple payment methods
• Payment with card + store payment data (token)
• Payment with stored payment data (token)
• Update stored payment data (token)
• Resend payment link
• Check the status of a link
• Cancel the validity of a link

Unique Identifier for Future Operations

Calls for "Sale with multiple payment methods", "Sale with card + tokenization", "Sale with token", "Update token", and "Retokenization" will generate a unique identifier for "Cancellation", "Query", or "Resend".

This identifier travels in the response of the initial call, in a field named with the order defined in the call. The response will have two possible formats, depending on the value of notify_on_creation defined in the request. An example response is added for each case.

Request with notify_on_creation=true

Payload (object)

• order_uuid_map (object): Object that will contain the link to process the payment.
  • order_operation
• real_uuid_map (object): Object that will contain the operation identifier for future operations.
  • order_operation: Unique identifier.
• errors (object):

Request with notify_on_creation=false

Payload (object)

• order_uuid_map (object):
  • order_operation(array) Array that will contain the link to process the payment and the unique identifier of the operation for future operations.
• real_uuid_map (object): Empty.
• errors (object):

Response with notification sent

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion": "https://sandbox.sipay.es/s/mm2at4"
    },
    "real_uuid_map": {
      "ejemplo_documentacion": "1a283efc-e0d6-11ec-b3ab-0242ac110024"
    },
    "errors": {}
  },
  "request_id": "6295fe0efca3a4d8081e6478",
  "uuid": "6295fe0efca3a4d8081e6478"
}

Response generating only the link

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion": [
        "e61fa602-e1b3-11ec-b3ab-0242ac110024",
        "https://sandbox.sipay.es/s/m4djt2"
      ]
    },
    "real_uuid_map": {},
    "errors": {}
  },
  "request_id": "6297722bfca3a4d8081e6618",
  "uuid": "6297722bfca3a4d8081e6618"
}

---