Payments
Payments Endpoints

>>>

GET /payments?page=&per=
List of payments

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Response

{
'payments': [
    {
      'id': '7678e2ce-b7cb-4265-9a30-39e3c565b9ff',
      'amount': '30666.66',
      'date': '2022-06-03',
      'status': 'canceled',
      'status_translated': 'Cancelado',
      'recipient_type': 'Investor',
      'source_folio': 'INV101-8-mxn',
      'source_id': 'a066e16c-290d-4eaa-88f5-0ba25a560f27',
      'recipient': { ... }
    },
    ...
  ]
}

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
>>>

GET /payments/:id
Specific payment

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Response

{
'payment': {
    'id': '7678e2ce-b7cb-4265-9a30-39e3c565b9ff',
    'amount': '30666.66',
    'date': '2022-06-03',
    'status': 'canceled',
    'status_translated': 'Cancelado',
    'recipient_type': 'Investor',
    'source_folio': 'INV101-8-mxn',
    'source_id': 'a066e16c-290d-4eaa-88f5-0ba25a560f27',
    'recipient': { ... }
  }
}

Params

Param name Description
id
required

Requested payment ID

Validations:

  • Must be a String