On this page
Payment Intent Recipient
NetworkService
NetworkService is used by recipient to create a payment intents
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| CreatePaymentIntent | CreatePaymentIntentRequest | CreatePaymentIntentResponse | |
| GetQuote | GetQuoteRequest | GetQuoteResponse |
RecipientService
RecipientService is implemented by recipient in order to get updates on payment intents
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| ConfirmPayIn | ConfirmPayInRequest | ConfirmPayInResponse | notifies recipient that pay-in providers received payment from payer |
| ConfirmPayment | ConfirmPaymentRequest | ConfirmPaymentResponse | notifies recipient about successful payment |
| RejectPaymentIntent | RejectPaymentIntentRequest | RejectPaymentIntentResponse | notifies recipient about failed payment |
Requests And Response Types
ConfirmPayInRequest
| Field | Type | Label | Description |
|---|---|---|---|
| payment_intent_id | uint64 | payment_intent_id from the CreatePaymentIntentResponse | |
| payment_reference | string | payment_reference from the CreatePaymentIntentRequest | |
| payment_method | tzero.v1.common.PaymentMethodType | pay-in payment method |
ConfirmPayInResponse
This message has no fields defined.
ConfirmPaymentRequest
| Field | Type | Label | Description |
|---|---|---|---|
| payment_intent_id | uint64 | payment_intent_id from the CreatePaymentIntentResponse | |
| payment_reference | string | payment_reference from the CreatePaymentIntentRequest | |
| payment_method | tzero.v1.common.PaymentMethodType | pay-in payment method | |
| pay_out_amount | tzero.v1.common.Decimal | amount which will be paid out denominated in pay_out_currency of the payment intent | |
| receipt | tzero.v1.common.PaymentReceipt | Payment receipt might contain metadata about payment recognizable by pay-in provider. |
ConfirmPaymentResponse
This message has no fields defined.
CreatePaymentIntentRequest
| Field | Type | Label | Description |
|---|---|---|---|
| payment_reference | string | Idempotency Key payment reference to identify payment by client. | |
| pay_in_currency | string | Pay-in currency | |
| pay_in_amount | tzero.v1.common.Decimal | Amount denominated in the pay-in currency | |
| pay_out_currency | string | Payout currency | |
| pay_out_details | tzero.v1.common.PaymentDetails | Payout payment details |
CreatePaymentIntentResponse
| Field | Type | Label | Description |
|---|---|---|---|
| payment_intent_id | uint64 | ||
| pay_in_payment_methods | CreatePaymentIntentResponse.PaymentMethod | repeated |
CreatePaymentIntentResponse.PaymentMethod
| Field | Type | Label | Description |
|---|---|---|---|
| payment_url | string | ||
| provider_id | uint32 | ||
| payment_method | tzero.v1.common.PaymentMethodType |
GetQuoteRequest
TODO: enrich with more fields
| Field | Type | Label | Description |
|---|---|---|---|
| pay_in_currency | string | Pay-in currency | |
| pay_in_amount | tzero.v1.common.Decimal | Amount denominated in the pay-in currency | |
| pay_out_currency | string | Payout currency | |
| pay_in_payment_method | tzero.v1.common.PaymentMethodType | payment method to use for the pay-in, e.g. bank transfer, card, etc. | |
| pay_out_payment_method | tzero.v1.common.PaymentMethodType | payment method to use for the pay-out, e.g. bank transfer, card, etc. |
GetQuoteResponse
| Field | Type | Label | Description |
|---|---|---|---|
| quote | GetQuoteResponse.Quote | ||
| not_found | GetQuoteResponse.NotFound |
GetQuoteResponse.NotFound
This message has no fields defined.
GetQuoteResponse.Quote
| Field | Type | Label | Description |
|---|---|---|---|
| rate | tzero.v1.common.Decimal | Rate of pay-in currency to pay-out | |
| expiration | google.protobuf.Timestamp | Time until when quote is valid. Used only for reference. Actual quote is determined at the moment of payment. |
RejectPaymentIntentRequest
| Field | Type | Label | Description |
|---|---|---|---|
| payment_intent_id | uint64 | payment_intent_id from the CreatePaymentIntentResponse | |
| payment_reference | string | payment_reference from the CreatePaymentIntentRequest | |
| reason | string |
RejectPaymentIntentResponse
This message has no fields defined.