---
updatedAt: 2025-05-19T21:41:32.000Z
agentTools:
  projectIndex: https://convera.readme.io/llms.txt
---

# Get Payment Instructions

Returns instructions on how to pay for a Convera order

```xml XSD
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning"
           xmlns:tns="http://api.globalpay.convera.com" targetNamespace="http://api.globalpay.convera.com"
           elementFormDefault="qualified" attributeFormDefault="unqualified" vc:minVersion="1.1">
	<xs:include schemaLocation="common.xsd"/>
	<xs:element name="paymentInstructionRequest" type="tns:PaymentInstructionRequestType"/>
	<xs:complexType name="PaymentInstructionRequestType">
		<xs:complexContent>
			<xs:extension base="tns:AbstractInputType">
				<xs:sequence>
					<xs:element name="dealReference" type="xs:string"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
</xs:schema>

```
```xml Sample Input
<paymentInstructionRequest xmlns="http://api.globalpay.convera.com">
    <dealReference>REF123456789</dealReference>
</paymentInstructionRequest>
```
```xml Sample Response
<paymentInstructionResponse xmlns="http://api.globalpay.convera.com">
    <status success="true"></status>
</paymentInstructionResponse>
```

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.1.0",
    "title": "Incoming API"
  },
  "x-explorer-enabled": false,
  "servers": [
    {
      "url": "https://uat.api.globalpay.convera.com/geo-api",
      "description": "Staging(UAT)"
    },
    {
      "url": "https://api.globalpay.convera.com/geo-api",
      "description": "Production"
    }
  ],
  "paths": {
    "/paymentInstruction": {
      "post": {
        "tags": [
          "Payment Instruction Resource"
        ],
        "summary": "Get Payment Instructions",
        "operationId": "paymentInstruction",
        "requestBody": {
          "content": {
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/paymentInstructionRequest"
              },
              "examples": {
                "PaymentInstructionExpected": {
                  "$ref": "#/components/examples/PaymentInstructionRequest"
                }
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/paymentInstructionRequest"
              }
            }
          },
          "description": "requestData",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/pdf": {
                "schema": {
                  "$ref": "#/components/schemas/paymentInstructionResponse"
                },
                "examples": {
                  "PaymentInstructionRespExpected": {
                    "$ref": "#/components/examples/PaymentInstructionResponseSuccess"
                  },
                  "PaymentInstructionRespErr": {
                    "$ref": "#/components/examples/PaymentInstructionResponseErr"
                  }
                }
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "content": {
              "application/xml": {
                "schema": {
                  "type": "object"
                }
              },
              "text/xml": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/xml": {
                "schema": {
                  "type": "object"
                }
              },
              "text/xml": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "paymentInstructionRequest": {
        "type": "object",
        "properties": {
          "dealReference": {
            "type": "string"
          }
        }
      },
      "paymentInstructionResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "`ER-1061:` The item referred to by the deal reference does not exist.\n"
                  }
                }
              }
            }
          }
        }
      }
    },
    "examples": {
      "PaymentInstructionRequest": {
        "value": "<paymentInstructionRequest xmlns=\"http://api.globalpay.wu.com\"> <dealReference>CUSRUESCH92366</dealReference> </paymentInstructionRequest>"
      },
      "PaymentInstructionResponseSuccess": {
        "value": "<paymentInstructionResponse xmlns=\"http://api.globalpay.wu.com\"> <status success=\"true\"> </status> </paymentInstructionResponse>"
      },
      "PaymentInstructionResponseErr": {
        "value": "<paymentInstructionResponse xmlns=\"http://api.globalpay.wu.com\"> <status success=\"false\"> <error code=\"ER-1061\">The item referred to by the deal reference does not exist.</error> </status> </paymentInstructionResponse>"
      }
    }
  },
  "x-readme": {
    "proxy-enabled": true
  }
}
```