Request for payment

Use these operations to interact with your payment requests.

Operation	Method	Description
Get requests for payment	GET	Gets requests for payment that match the query parameters.
Send request for payment	POST	Sends a new request for payment.
Get request for payment by ID	GET	Gets a request for payment by request for payment ID.
Accept request for payment	POST	Accepts a request for payment.
Fail request for payment	POST	Fails a request for payment.

Operações

Get requests for payment

Requisição

Gets requests for payment that match the query parameters.

Segurança

Bearer

Consulta

end_to_end_idstring

Optional parameter to filter results matching this endToEndId value.

statestring

State by which to filter results.

Enum:"REQUESTED""ACCEPTED""FAILED"

sender_addressstring

Field to filter results matching this senderAddress value.

receiver_addressstring

Field to filter results matching this receiverAddress value.

payment_idstring, (uuid)

Field to filter results matching this paymentId value.

beforestring

Filters for requests for payment whose range_field column value is before this specified time stamp (not inclusive). You can also specify after to create a time range between after and before. If before is specified, range_field must also be specified

afterstring

Filters for requests for payment whose range_field column value is after this specified time stamp (not inclusive). You can also specify before to create a time range between after and before. If after is specified, range_field must also be specified.

range_fieldstring

Designates the column name of the requests for payment database table that is used for filtering payments before/after/between time stamps. For example, if you specify range_field=MODIFIED_AT, you would specify a time stamp (in the 24 character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in request for payment objects) as the value for before and/or after to fetch request for payment before, after, or between the specified time range(s) (not inclusive). If range_field is specified, before and/or after must also be specified.

Enum:"CREATED_AT""MODIFIED_AT"

sort_fieldstring

Field to use to sort results.

Enum:"CREATED_AT""MODIFIED_AT"

sort_directionstring

Sorts result according to the specified direction.

Padrão:"DESC"

Enum:"ASC""DESC"

pageinteger

Zero-based index of the page number of results.

Padrão:0

sizeinteger

The number of payments per page.

Padrão:10

curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request_for_payment?end_to_end_id=string&state=REQUESTED&sender_address=string&receiver_address=string&payment_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&before=string&after=string&range_field=CREATED_AT&sort_field=CREATED_AT&sort_direction=ASC&page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respostas

Successfully retrieves requests for payment matching query parameters.

Corpoapplication/json

firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger, (int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

contentArray of objects

Resposta

{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}