Pular para o conteúdo

Fail request for payment

Requisição

Fails a request for payment.

Segurança
Bearer
Caminho
request_for_payment_idstring, (uuid)obrigatório

Unique identifier of the request for payment to fail.

Corpoapplication/jsonobrigatório

The request object to fail a request for payment.

user_infoobject

User-provided data with arbitrary key/value pairs.

curl -i -X POST \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/request_for_payment/{request_for_payment_id}/fail' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_info": {}
  }'

Respostas

Successfully fails a request for payment resulting in a request for payment object in the FAILED state.

Corpoapplication/json
request_for_payment_idstring, (uuid)obrigatório

Unique identifier of a request for payment.

Exemplo:"1bf93760-ef69-4697-b2b4-47d9e1c42aa7"
request_for_payment_statestringobrigatório

State of the request for payment.

Enum:"REQUESTED""ACCEPTED""FAILED"
Exemplo:"REQUESTED"
sender_addressstringobrigatório

RippleNet address of the node that is receiving the request for payment, or the eventual sender of the payment.

Exemplo:"trans_usd_sf@rn.us.ca.san_francisco"
receiver_addressstringobrigatório

RippleNet address of the node that is sending the request for payment, or the eventual receiver of the payment.

Exemplo:"trans_gbp_lon@rn.eur.uk.london"
amountnumberobrigatório

Amount requested to be paid.

Exemplo:100.01
currencystringobrigatório

Currency code for the amount value.

Exemplo:"USD"
quote_typestringobrigatório

Indicates how the amount field should be treated for calculating quote values.

Enum:"SENDER_AMOUNT""RECEIVER_AMOUNT""SENDER_INSTITUTION_AMOUNT""RECEIVER_INSTITUTION_AMOUNT"
Exemplo:"SENDER_AMOUNT"
end_to_end_idstring

ID that the eventual payment receiver can specify. Persisted on all rippleNet Node instances (namely, the sender and receiver of the payment) that participate in the request for payment.

user_infoArray of objectsobrigatório

User-provided data with arbitrary key/value pairs.

created_atstring, (date-time)obrigatório

Date and time at which the request for payment was created, as an ISO-8601 timestamp in UTC.

payment_idstring, (uuid)

Unique identifier of a payment associated to request for payment.

Exemplo:"5492648d-2132-4e70-9ded-2fc86f22b321"
Resposta
{ "request_for_payment_id": "1bf93760-ef69-4697-b2b4-47d9e1c42aa7", "request_for_payment_state": "REQUESTED", "sender_address": "trans_usd_sf@rn.us.ca.san_francisco", "receiver_address": "trans_gbp_lon@rn.eur.uk.london", "amount": 100.01, "currency": "USD", "quote_type": "SENDER_AMOUNT", "end_to_end_id": "string", "user_info": [ { … } ], "created_at": "2019-08-24T14:15:22Z", "payment_id": "5492648d-2132-4e70-9ded-2fc86f22b321" }