Export Payments

GET 
/exports/payments

Exports a CSV file of payments.

Request

Query Parameters

status PaymentStatus
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED, CANCELED]
Exact match on the status of the payment.
Example: DRAFT
receiver_id string
UUID that represents a receiver in the database
Example: b6b667ad-6cc2-46cf-9be7-561daace7d48
created_at_after string
Only return payments that are created after this date. Format: YYYY-MM-DD
Example: 2006-01-02
created_at_before string
Only return payments that are created before this date. Format: YYYY-MM-DD
Example: 2006-01-02
sort string

Possible values: [created_at]

Default value: created_at

Field used to sort payments.

direction string

Possible values: [asc, desc]

Default value: asc

Direction for sorting payments.

Responses

200

CSV file of payments

text/csv

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

application/json

Schema

Schema

any

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

*/*

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

application/json

Schema

Schema

any

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

Loading...