Display the payment instances of the document.

Request

Authorization

Add parameter in header

Company-Token

Example:

Company-Token: ********************

Path Params

code

string

required

Header Params

Accept

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.test.apipagos.com/api/v2/apipagos/documents//payment-instances' \
--header 'Accept: application/json' \
--header 'Company-Token;'

Responses

🟢200OK

application/json

Body

data

array[object (Document Payment Instance) {5}]

required

document

object (Document)

optional

amount

integer <fixed64>

required

expired_at

string <date-time> | null

required

created_at

string <date-time>

required

updated_at

string <date-time>

required

Example

{
  "data": [
    {
      "document": {
        "code": "string",
        "type": {
          "type_code": "string",
          "title": "string",
          "description": "string",
          "documents_source": "string",
          "transactions_source": "string",
          "program_type": "string",
          "status": {
            "code": 0,
            "label": "string",
            "description": "string",
            "action": "showHelp"
          },
          "config": "string"
        },
        "title": "string",
        "currency_code": "string",
        "amount": "string",
        "parent": {},
        "integrity_code": "string",
        "status": {
          "code": 0,
          "label": "string",
          "description": "string",
          "action": "showHelp"
        },
        "field_1": "string",
        "field_2": "string",
        "field_3": "string",
        "user": {
          "code": "string",
          "correlation_id": "string",
          "type": "f",
          "email": "string",
          "email_verified_at": "2019-08-24T14:15:22Z",
          "first_name": "string",
          "last_name": "string",
          "field_1": "string",
          "field_2": "string",
          "field_3": "string",
          "profile_photo_url": "string",
          "birthdate": "2019-08-24T14:15:22Z",
          "birth_country": "string",
          "nationality": "string",
          "gender": "string",
          "marital_status": "Single",
          "status": {
            "code": 0,
            "label": "string",
            "description": "string",
            "action": "showHelp"
          },
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "amount": 0,
      "expired_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}